<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    <title>Wi-Fi Host Driver (WHD): WHD Wi-Fi IOCTL Set/Get API</title>
    <link href="tabs.css" rel="stylesheet" type="text/css"/>
    <script type="text/javascript" src="jquery.js"></script>
    <script type="text/javascript" src="dynsections.js"></script>
    <link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
    <link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="doxygen.css" rel="stylesheet" type="text/css" />
  </head>
  <body>
    <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
      <div id="titlearea" style="font-family:verdana;">
        <table border='0' cellpadding='0' cellspacing='0' width="98%">
          <tr style="height:20px"><td>&nbsp;</td></tr>
          <tr style="border-collapse: collapse; padding: 0;">
            <td style="width:20px"></td>
            <td style="width:117px"><img src="cypress_logo.png" alt="Cypress Logo" /></td>
            <td style="width:20px;background-image:url('cypresslogo_line.png');"></td>
            <td style="vertical-align:middle; text-align:center; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;background-image:url('cypresslogo_line.png');">
              Wi-Fi Host Driver (WHD) Public API Reference Guide
            </td>
          </tr>
          <tr><td>&nbsp;</td></tr>
        </table>
    </div>
    <!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__wifiioctl.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">WHD Wi-Fi IOCTL Set/Get API<div class="ingroups"><a class="el" href="group__wifi.html">WHD Wi-Fi API</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>Set and get IOCTL values. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad54ac84589a14cc97429bf138fa32639"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifiioctl.html#gad54ac84589a14cc97429bf138fa32639">whd_wifi_set_ioctl_value</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, uint32_t ioctl, uint32_t value)</td></tr>
<tr class="memdesc:gad54ac84589a14cc97429bf138fa32639"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends an IOCTL command - CDC_SET IOCTL value.  <a href="#gad54ac84589a14cc97429bf138fa32639">More...</a><br /></td></tr>
<tr class="separator:gad54ac84589a14cc97429bf138fa32639"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga817655c1372b8c87608b204105f06937"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifiioctl.html#ga817655c1372b8c87608b204105f06937">whd_wifi_get_ioctl_value</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, uint32_t ioctl, uint32_t *value)</td></tr>
<tr class="memdesc:ga817655c1372b8c87608b204105f06937"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends an IOCTL command - CDC_GET IOCTL value.  <a href="#ga817655c1372b8c87608b204105f06937">More...</a><br /></td></tr>
<tr class="separator:ga817655c1372b8c87608b204105f06937"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d7aec7622caacf4a0642cf1da1fa647"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifiioctl.html#ga5d7aec7622caacf4a0642cf1da1fa647">whd_wifi_set_ioctl_buffer</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, uint32_t ioctl, void *buffer, uint16_t buffer_length)</td></tr>
<tr class="memdesc:ga5d7aec7622caacf4a0642cf1da1fa647"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends an IOCTL command - CDC_SET IOCTL buffer.  <a href="#ga5d7aec7622caacf4a0642cf1da1fa647">More...</a><br /></td></tr>
<tr class="separator:ga5d7aec7622caacf4a0642cf1da1fa647"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab1a4c2ae9163408ae92b3f292ee2807f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifiioctl.html#gab1a4c2ae9163408ae92b3f292ee2807f">whd_wifi_get_ioctl_buffer</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, uint32_t ioctl, uint8_t *out_buffer, uint16_t out_length)</td></tr>
<tr class="memdesc:gab1a4c2ae9163408ae92b3f292ee2807f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends an IOCTL command - CDC_GET IOCTL buffer.  <a href="#gab1a4c2ae9163408ae92b3f292ee2807f">More...</a><br /></td></tr>
<tr class="separator:gab1a4c2ae9163408ae92b3f292ee2807f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2b1cdfc36df80ca4700076fd2747b34e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifiioctl.html#ga2b1cdfc36df80ca4700076fd2747b34e">whd_wifi_get_iovar_buffer_with_param</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, const char *iovar_name, void *param, uint32_t paramlen, uint8_t *out_buffer, uint32_t out_length)</td></tr>
<tr class="memdesc:ga2b1cdfc36df80ca4700076fd2747b34e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends an IOVAR command.  <a href="#ga2b1cdfc36df80ca4700076fd2747b34e">More...</a><br /></td></tr>
<tr class="separator:ga2b1cdfc36df80ca4700076fd2747b34e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad54ac84589a14cc97429bf138fa32639"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad54ac84589a14cc97429bf138fa32639">&#9670;&nbsp;</a></span>whd_wifi_set_ioctl_value()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t whd_wifi_set_ioctl_value </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>ioctl</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sends an IOCTL command - CDC_SET IOCTL value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">ioctl</td><td>CDC_SET - To set the I/O control </td></tr>
    <tr><td class="paramname">value</td><td>Data value to be sent</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS or Error code </dd></dl>

</div>
</div>
<a id="ga817655c1372b8c87608b204105f06937"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga817655c1372b8c87608b204105f06937">&#9670;&nbsp;</a></span>whd_wifi_get_ioctl_value()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t whd_wifi_get_ioctl_value </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>ioctl</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sends an IOCTL command - CDC_GET IOCTL value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">ioctl</td><td>CDC_GET - To get the I/O control </td></tr>
    <tr><td class="paramname">value</td><td>Pointer to receive the data value</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS or Error code </dd></dl>

</div>
</div>
<a id="ga5d7aec7622caacf4a0642cf1da1fa647"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d7aec7622caacf4a0642cf1da1fa647">&#9670;&nbsp;</a></span>whd_wifi_set_ioctl_buffer()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t whd_wifi_set_ioctl_buffer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>ioctl</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>buffer_length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sends an IOCTL command - CDC_SET IOCTL buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">ioctl</td><td>CDC_SET - To set the I/O control </td></tr>
    <tr><td class="paramname">buffer</td><td>Handle for a packet buffer containing the data value to be sent. </td></tr>
    <tr><td class="paramname">buffer_length</td><td>Length of buffer</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS or Error code </dd></dl>

</div>
</div>
<a id="gab1a4c2ae9163408ae92b3f292ee2807f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab1a4c2ae9163408ae92b3f292ee2807f">&#9670;&nbsp;</a></span>whd_wifi_get_ioctl_buffer()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t whd_wifi_get_ioctl_buffer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>ioctl</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>out_buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>out_length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sends an IOCTL command - CDC_GET IOCTL buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">ioctl</td><td>CDC_GET - To get the I/O control </td></tr>
    <tr><td class="paramname">out_buffer</td><td>Pointer to receive the handle for the packet buffer containing the response data value received </td></tr>
    <tr><td class="paramname">out_length</td><td>Length of out_buffer</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS or Error code </dd></dl>

</div>
</div>
<a id="ga2b1cdfc36df80ca4700076fd2747b34e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2b1cdfc36df80ca4700076fd2747b34e">&#9670;&nbsp;</a></span>whd_wifi_get_iovar_buffer_with_param()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t whd_wifi_get_iovar_buffer_with_param </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>iovar_name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>param</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>paramlen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>out_buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>out_length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sends an IOVAR command. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">iovar_name</td><td>SDPCM_GET - To get the I/O Variable </td></tr>
    <tr><td class="paramname">param</td><td>Paramater to be passed for the IOVAR </td></tr>
    <tr><td class="paramname">paramlen</td><td>Paramter length </td></tr>
    <tr><td class="paramname">out_buffer</td><td>Pointer to receive the handle for the packet buffer containing the response data value received </td></tr>
    <tr><td class="paramname">out_length</td><td>Length of out_buffer</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS or Error code </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
    <!-- start footer part -->
    <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
      <ul>
        <li class="footer">Copyright Cypress Corporation.</li>
      </ul>
    </div>
  </body>
</html>
